/*
 * Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */
/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Xerces" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 1999, International
 * Business Machines, Inc., http://www.apache.org.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package com.sun.org.apache.xerces.internal.impl.dtd;

import com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarDescription;
import java.util.Hashtable;

/**
 * This very simple class is the skeleton of what the DTDValidator could use
 * to store various grammars that it gets from the GrammarPool.  As in the
 * case of XSGrammarBucket, one thinks of this object as being closely
 * associated with its validator; when fully mature, this class will be
 * filled from the GrammarPool when the DTDValidator is invoked on a
 * document, and, if a new DTD grammar is parsed, the new set will be
 * offered back to the GrammarPool for possible inclusion.
 *
 * @author Neil Graham, IBM
 * @xerces.internal
 */
public class DTDGrammarBucket {

  // REVISIT:  make this class smarter and *way* more complete!

  //
  // Data
  //

  /**
   * Grammars associated with element root name.
   */
  protected Hashtable fGrammars;

  // the unique grammar from fGrammars (or that we're
  // building) that is used in validation.
  protected DTDGrammar fActiveGrammar;

  // is the "active" grammar standalone?
  protected boolean fIsStandalone;

  //
  // Constructors
  //

  /**
   * Default constructor.
   */
  public DTDGrammarBucket() {
    fGrammars = new Hashtable();
  } // <init>()

  //
  // Public methods
  //

  /**
   * Puts the specified grammar into the grammar pool and associate it to
   * a root element name (this being internal, the lack of generality is irrelevant).
   *
   * @param grammar The grammar.
   */
  public void putGrammar(DTDGrammar grammar) {
    XMLDTDDescription desc = (XMLDTDDescription) grammar.getGrammarDescription();
    fGrammars.put(desc, grammar);
  } // putGrammar(DTDGrammar)

  // retrieve a DTDGrammar given an XMLDTDDescription
  public DTDGrammar getGrammar(XMLGrammarDescription desc) {
    return (DTDGrammar) (fGrammars.get((XMLDTDDescription) desc));
  } // putGrammar(DTDGrammar)

  public void clear() {
    fGrammars.clear();
    fActiveGrammar = null;
    fIsStandalone = false;
  } // clear()

  // is the active grammar standalone?  This must live here because
  // at the time the validator discovers this we don't yet know
  // what the active grammar should be (no info about root)
  void setStandalone(boolean standalone) {
    fIsStandalone = standalone;
  }

  boolean getStandalone() {
    return fIsStandalone;
  }

  // set the "active" grammar:
  void setActiveGrammar(DTDGrammar grammar) {
    fActiveGrammar = grammar;
  }

  DTDGrammar getActiveGrammar() {
    return fActiveGrammar;
  }
} // class DTDGrammarBucket
